<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
        "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
	<head>
		<meta http-equiv="content-type" content="text/html; charset=utf-8" />
		<meta name="generator" content="JsDoc Toolkit" />
		
		<title>JsDoc Reference - opensocial.flash</title>

		<style type="text/css">
			/* default.css */
body
{
	font: 12px "Lucida Grande", Tahoma, Arial, Helvetica, sans-serif;
	width: 800px;
}

.header
{
	clear: both;
	background-color: #ccc;
	padding: 8px;
}

h1
{
	font-size: 150%;
	font-weight: bold;
	padding: 0;
	margin: 1em 0 0 .3em;
}

hr
{
	border: none 0;
	border-top: 1px solid #7F8FB1;
	height: 1px;
}

pre.code
{
	display: block;
	padding: 8px;
	border: 1px dashed #ccc;
}

#index
{
	margin-top: 24px;
	float: left;
	width: 160px;
	position: absolute;
	left: 8px;
	background-color: #F3F3F3;
	padding: 8px;
}

#content
{
	margin-left: 190px;
	width: 600px;
}

.classList
{
	list-style-type: none;
	padding: 0;
	margin: 0 0 0 8px;
	font-family: arial, sans-serif;
	font-size: 1em;
	overflow: auto;
}

.classList li
{
	padding: 0;
	margin: 0 0 8px 0;
}

.summaryTable { width: 100%; }

h1.classTitle
{
	font-size:170%;
	line-height:130%;
}

h2 { font-size: 110%; }
caption, div.sectionTitle
{
	background-color: #7F8FB1;
	color: #fff;
	font-size:130%;
	text-align: left;
	padding: 2px 6px 2px 6px;
	border: 1px #7F8FB1 solid;
}

div.sectionTitle { margin-bottom: 8px; }
.summaryTable thead { display: none; }

.summaryTable td
{
	vertical-align: top;
	padding: 4px;
	border-bottom: 1px #7F8FB1 solid;
	border-right: 1px #7F8FB1 solid;
}

/*col#summaryAttributes {}*/
.summaryTable td.attributes
{
	border-left: 1px #7F8FB1 solid;
	width: 140px;
	text-align: right;
}

td.attributes, .fixedFont
{
	line-height: 15px;
	color: #002EBE;
	font-family: "Courier New",Courier,monospace;
	font-size: 13px;
}

.summaryTable td.nameDescription
{
	text-align: left;
	font-size: 13px;
	line-height: 15px;
}

.summaryTable td.nameDescription, .description
{
	line-height: 15px;
	padding: 4px;
	padding-left: 4px;
}

.summaryTable { margin-bottom: 8px; }

ul.inheritsList
{
	list-style: square;
	margin-left: 20px;
	padding-left: 0;
}

.detailList {
	margin-left: 20px; 
	line-height: 15px;
}
.detailList dt { margin-left: 20px; }

.detailList .heading
{
	font-weight: bold;
	padding-bottom: 6px;
	margin-left: 0;
}

.light, td.attributes, .light a:link, .light a:visited
{
	color: #777;
	font-style: italic;
}

.fineprint
{
	text-align: right;
	font-size: 10px;
}
		</style>
	</head>

	<body>
<!-- ============================== header ================================= -->	
		<!-- begin static/header.html -->
		<div id="header">
</div>
		<!-- end static/header.html -->

<!-- ============================== classes index ============================ -->
		<div id="index">
			<!-- begin publish.classesIndex -->
			<div align="center"><a href="../index.html">Class Index</a>
| <a href="../files.html">File Index</a></div>
<hr />
<h2>Classes</h2>
<ul class="classList">
	
	<li><a href="../symbols/gadgets.html">gadgets</a></li>
	
	<li><a href="../symbols/opensocial.html">opensocial</a></li>
	
	<li><a href="../symbols/opensocial.flash.html">opensocial.flash</a></li>
	
	<li><i><a href="../symbols/_global_.html">_global_</a></i></li>
	
</ul>
<hr />
			<!-- end publish.classesIndex -->
		</div>
		
		<div id="content">
<!-- ============================== class title ============================ -->
			<h1 class="classTitle">
				
				Namespace opensocial.flash
			</h1>

<!-- ============================== class summary ========================== -->			
			<p class="description">
				
			
				Namespace for top-level api functions.
				
				
					<br /><i>Defined in: </i> <a href="../symbols/src/C__LocalHome_Project_Makamaka_src_opensocial-actionscript-client-sdk_src_org_opensocial_client_jswrapper_javascript_opensocial-flashsdk.js.html">opensocial-flashsdk.js</a>.
				
			</p>

<!-- ============================== constructor summary ==================== -->			
			
			<table class="summaryTable" cellspacing="0" summary="A summary of the constructor documented in the class opensocial.flash.">
				<caption>Namespace Summary</caption>
				<thead>
					<tr>
						<th scope="col">Constructor Attributes</th>
						<th scope="col">Constructor Name and Description</th>
					</tr>
				</thead>
				<tbody>
					<tr>
						<td class="attributes">&nbsp;</td>
						<td class="nameDescription" >
							<div class="fixedFont">
								<b><a href="../symbols/opensocial.flash.html">opensocial.flash</a></b>
							</div>
							<div class="description"></div>
						</td>
					</tr>
				</tbody>
			</table>
			

<!-- ============================== properties summary ===================== -->
			

<!-- ============================== methods summary ======================== -->
			
				
				
				<table class="summaryTable" cellspacing="0" summary="A summary of the methods documented in the class opensocial.flash.">
					<caption>Method Summary</caption>
					<thead>
						<tr>
							<th scope="col">Method Attributes</th>
							<th scope="col">Method Name and Description</th>
						</tr>
					</thead>
					<tbody>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.embedFlash">embedFlash</a></b>(swfUrl, swfContainer, opt_playerVersion, opt_params, opt_upgradeMsgHTML)
								</div>
								<div class="description">Because <code>gadgets.flash.embedFlash</code> cannot auto activate it in IE6, so here we
need a special one.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.getFlash">getFlash</a></b>(opt_name)
								</div>
								<div class="description">Get the swf object.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.supportsField">supportsField</a></b>(objectType, The)
								</div>
								<div class="description">Check if the field is supported in the object type.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.getDomain">getDomain</a></b>()
								</div>
								<div class="description">Returns the domain from environment instance.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.getContainerDomain">getContainerDomain</a></b>()
								</div>
								<div class="description">Returns the domain from the referer.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.getCurrentView">getCurrentView</a></b>()
								</div>
								<div class="description">Returns the name of the in gadgets.views static class.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.getViewParams">getViewParams</a></b>()
								</div>
								<div class="description">Returns the parameters passed into this gadget for this view.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.isOnlyVisible">isOnlyVisible</a></b>()
								</div>
								<div class="description">Indicates if the app is only one gadget on the page or not.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.setStageWidth">setStageWidth</a></b>(newWidth)
								</div>
								<div class="description">Sets the width for the flash stage.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.setStageHeight">setStageHeight</a></b>(newHeight)
								</div>
								<div class="description">Sets the height for the flash stage.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.setTitle">setTitle</a></b>(newTitle)
								</div>
								<div class="description">Sets the title of this app.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.fetchPerson">fetchPerson</a></b>(reqID, id, opt_params)
								</div>
								<div class="description">Sends out the request for a person.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.fetchPeople">fetchPeople</a></b>(reqID, idSpec, opt_params)
								</div>
								<div class="description">Sends out the request for friends of a person.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.fetchPersonAppData">fetchPersonAppData</a></b>(reqID, idSpec, keys, opt_params)
								</div>
								<div class="description">Sends out the request for personal app data.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.updatePersonAppData">updatePersonAppData</a></b>(reqID, id, key, value)
								</div>
								<div class="description">Sends out the update request for personal app data.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.removePersonAppData">removePersonAppData</a></b>(reqID, id, keys)
								</div>
								<div class="description">Sends out the remove request for personal app data.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.fetchActivities">fetchActivities</a></b>(reqID, idSpec, opt_params)
								</div>
								<div class="description">Sends out the request for personal activities.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.requestCreateActivity">requestCreateActivity</a></b>(reqID, activity, priority)
								</div>
								<div class="description">Sends out the request to creat an activity.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.requestSendMessage">requestSendMessage</a></b>(reqID, recipients, message)
								</div>
								<div class="description">Sends out the request to send a message.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.requestShareApp">requestShareApp</a></b>(reqID, recipients, reason)
								</div>
								<div class="description">Sends out the request to share the app.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.requestPermission">requestPermission</a></b>(reqID, permissions, reason)
								</div>
								<div class="description">Sends out the request permissions.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.makeRequest">makeRequest</a></b>(reqID, url, opt_params)
								</div>
								<div class="description">Sends request to a remote site to get or post data.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.callRpc">callRpc</a></b>(reqID, targetId, serviceName, argsArray)
								</div>
								<div class="description">Sends the rpc call request to a service on another app or container on the page.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.returnRpcService">returnRpcService</a></b>(callID, opt_returnValue)
								</div>
								<div class="description">Sends the return value to to last received rpc service back to the caller app.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.registerRpcService">registerRpcService</a></b>(serviceName, handlerName)
								</div>
								<div class="description">Sends the rpc register request to container to register a service on this app.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.unregisterRpcService">unregisterRpcService</a></b>(serviceName)
								</div>
								<div class="description">Sends the rpc unregister request to container.</div>
							</td>
						</tr>
					
						<tr>
							<td class="attributes">&lt;static&gt; &nbsp;</td>
							<td class="nameDescription">
								<div class="fixedFont">opensocial.flash.<b><a href="../symbols/opensocial.flash.html#.jsReady">jsReady</a></b>(objectId)
								</div>
								<div class="description">Indicates if the opensocial library is loaded and initialize the flash element.</div>
							</td>
						</tr>
					
					</tbody>
				</table>
				
				
				
			
<!-- ============================== events summary ======================== -->
			

<!-- ============================== constructor details ==================== -->		
			
			<div class="details"><a name="constructor"> </a>
				<div class="sectionTitle">
					Namespace Detail
				</div>
				
				<div class="fixedFont">
						<b>opensocial.flash</b>
				</div>
				
				<div class="description">
					
					
				</div>
				
				
				
				
					
					
					
					
					
					
						<dl class="detailList">
						<dt class="heading">Requires:</dt>
						
							<dd>opensocial</dd>
						
							<dd>gadgets</dd>
						
						</dl>
					
					

			</div>
			

<!-- ============================== field details ========================== -->		
			

<!-- ============================== method details ========================= -->		
			
				<div class="sectionTitle">
					Method Detail
				</div>
				
					<a name=".embedFlash"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{boolean}</span>
					<span class="light">opensocial.flash.</span><b>embedFlash</b>(swfUrl, swfContainer, opt_playerVersion, opt_params, opt_upgradeMsgHTML)
					
					</div>
					<div class="description">
						Because <code>gadgets.flash.embedFlash</code> cannot auto activate it in IE6, so here we
need a special one.
<p>
NOTE: to be deprecated.
</p>
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>swfUrl</b>
									
								</dt>
								<dd>The swf file's location.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>swfContainer</b>
									
								</dt>
								<dd>The HTML element id.</dd>
							
								<dt>
									<span class="light fixedFont">{string?}</span> <b>opt_playerVersion</b>
									
								</dt>
								<dd>Required flash player version.</dd>
							
								<dt>
									<span class="light fixedFont">{Object.<string|string>?}</span> <b>opt_params</b>
									
								</dt>
								<dd>Flash object's parameters.</dd>
							
								<dt>
									<span class="light fixedFont">{string?}</span> <b>opt_upgradeMsgHTML</b>
									
								</dt>
								<dd>The message if the flashplayer version is too old.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> True if the flash object is successfully embeded.</dd>
							
							</dl>
						
						
							<dl class="detailList">
							<dt class="heading">Requires:</dt>
							
								<dd>gadgets.flash</dd>
							
							</dl>
						
						

					<hr />
				
					<a name=".getFlash"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{HTMLElement}</span>
					<span class="light">opensocial.flash.</span><b>getFlash</b>(opt_name)
					
					</div>
					<div class="description">
						Get the swf object.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string?}</span> <b>opt_name</b>
									
								</dt>
								<dd>The object/embed tag's id or name</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{HTMLElement}</span> the swf object.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".supportsField"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{boolean}</span>
					<span class="light">opensocial.flash.</span><b>supportsField</b>(objectType, The)
					
					</div>
					<div class="description">
						Check if the field is supported in the object type.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{opensocial.Environment.ObjectType | string}</span> <b>objectType</b>
									
								</dt>
								<dd>The enum name of the type.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>The</b>
									
								</dt>
								<dd>enum name of the field, defined in opensocial.XXXX.Field enums.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> True if supported.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getDomain"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{string}</span>
					<span class="light">opensocial.flash.</span><b>getDomain</b>()
					
					</div>
					<div class="description">
						Returns the domain from environment instance.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{string}</span> The domain</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getContainerDomain"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{string}</span>
					<span class="light">opensocial.flash.</span><b>getContainerDomain</b>()
					
					</div>
					<div class="description">
						Returns the domain from the referer.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{string}</span> The domain.</dd>
							
							</dl>
						
						
						

					<hr />
				
					<a name=".getCurrentView"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{gadgets.views.ViewType | string}</span>
					<span class="light">opensocial.flash.</span><b>getCurrentView</b>()
					
					</div>
					<div class="description">
						Returns the name of the in gadgets.views static class.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{gadgets.views.ViewType | string}</span> The view name.</dd>
							
							</dl>
						
						
							<dl class="detailList">
							<dt class="heading">Requires:</dt>
							
								<dd>gadgets.views</dd>
							
							</dl>
						
						

					<hr />
				
					<a name=".getViewParams"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Object.<string|string>}</span>
					<span class="light">opensocial.flash.</span><b>getViewParams</b>()
					
					</div>
					<div class="description">
						Returns the parameters passed into this gadget for this view.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Object.<string|string>}</span> The param object.</dd>
							
							</dl>
						
						
							<dl class="detailList">
							<dt class="heading">Requires:</dt>
							
								<dd>gadgets.views</dd>
							
							</dl>
						
						

					<hr />
				
					<a name=".isOnlyVisible"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{Boolean}</span>
					<span class="light">opensocial.flash.</span><b>isOnlyVisible</b>()
					
					</div>
					<div class="description">
						Indicates if the app is only one gadget on the page or not.
						
						
					</div>
					
					
					
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{Boolean}</span> True if it's the only one gadget.</dd>
							
							</dl>
						
						
							<dl class="detailList">
							<dt class="heading">Requires:</dt>
							
								<dd>gadget.views</dd>
							
							</dl>
						
						

					<hr />
				
					<a name=".setStageWidth"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">opensocial.flash.</span><b>setStageWidth</b>(newWidth)
					
					</div>
					<div class="description">
						Sets the width for the flash stage. It is very usefull for dynamic loading and view
switching.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{number}</span> <b>newWidth</b>
									
								</dt>
								<dd>New width (in pixel) to be applied.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".setStageHeight"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">opensocial.flash.</span><b>setStageHeight</b>(newHeight)
					
					</div>
					<div class="description">
						Sets the height for the flash stage. It is very usefull for dynamic loading and view
switching.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{number}</span> <b>newHeight</b>
									
								</dt>
								<dd>New height (in pixel) to be applied.</dd>
							
							</dl>
						
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Requires:</dt>
							
								<dd>gadgets.window</dd>
							
							</dl>
						
						

					<hr />
				
					<a name=".setTitle"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">opensocial.flash.</span><b>setTitle</b>(newTitle)
					
					</div>
					<div class="description">
						Sets the title of this app.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>newTitle</b>
									
								</dt>
								<dd>New title to be applied.</dd>
							
							</dl>
						
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Requires:</dt>
							
								<dd>gadgets.window</dd>
							
							</dl>
						
						

					<hr />
				
					<a name=".fetchPerson"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">opensocial.flash.</span><b>fetchPerson</b>(reqID, id, opt_params)
					
					</div>
					<div class="description">
						Sends out the request for a person.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>reqID</b>
									
								</dt>
								<dd>The request id.</dd>
							
								<dt>
									<span class="light fixedFont">{opensocial.IdSpec.PersonId | string}</span> <b>id</b>
									
								</dt>
								<dd>OWNER or VIEWER.</dd>
							
								<dt>
									<span class="light fixedFont">{Object.<opensocial.DataRequest.PeopleRequestField|Object>}</span> <b>opt_params</b>
									
								</dt>
								<dd>A map of <code>opensocial.DataRequest.PeopleRequestField</code> names and values.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".fetchPeople"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">opensocial.flash.</span><b>fetchPeople</b>(reqID, idSpec, opt_params)
					
					</div>
					<div class="description">
						Sends out the request for friends of a person.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>reqID</b>
									
								</dt>
								<dd>The request id.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>idSpec</b>
									
								</dt>
								<dd>A wrapped <code>opensocial.IdSpec</code> object.</dd>
							
								<dt>
									<span class="light fixedFont">{Object.<opensocial.DataRequest.PeopleRequestField|Object>}</span> <b>opt_params</b>
									
								</dt>
								<dd>A map of <code>opensocial.DataRequest.PeopleRequestField</code> names and values.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".fetchPersonAppData"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">opensocial.flash.</span><b>fetchPersonAppData</b>(reqID, idSpec, keys, opt_params)
					
					</div>
					<div class="description">
						Sends out the request for personal app data.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>reqID</b>
									
								</dt>
								<dd>The request id.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>idSpec</b>
									
								</dt>
								<dd>A wrapped <code>opensocial.IdSpec</code> object.</dd>
							
								<dt>
									<span class="light fixedFont">{Array.<string>}</span> <b>keys</b>
									
								</dt>
								<dd>App keys, '*' for all.</dd>
							
								<dt>
									<span class="light fixedFont">{Object.<opensocial.DataRequest.DataRequestField|Object>?}</span> <b>opt_params</b>
									
								</dt>
								<dd>A map of <code>opensocial.DataRequest.DataRequestField</code> names and values.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".updatePersonAppData"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">opensocial.flash.</span><b>updatePersonAppData</b>(reqID, id, key, value)
					
					</div>
					<div class="description">
						Sends out the update request for personal app data.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>reqID</b>
									
								</dt>
								<dd>The request id.</dd>
							
								<dt>
									<span class="light fixedFont">{opensocial.IdSpec.PersonId | string}</span> <b>id</b>
									
								</dt>
								<dd>only VIEWER is valid</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>key</b>
									
								</dt>
								<dd>A data key.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>value</b>
									
								</dt>
								<dd>New value.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".removePersonAppData"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">opensocial.flash.</span><b>removePersonAppData</b>(reqID, id, keys)
					
					</div>
					<div class="description">
						Sends out the remove request for personal app data.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>reqID</b>
									
								</dt>
								<dd>The request id.</dd>
							
								<dt>
									<span class="light fixedFont">{opensocial.IdSpec.PersonId | string}</span> <b>id</b>
									
								</dt>
								<dd>only VIEWER is valid</dd>
							
								<dt>
									<span class="light fixedFont">{Array.<string>}</span> <b>keys</b>
									
								</dt>
								<dd>App keys, '*' for all.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".fetchActivities"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">opensocial.flash.</span><b>fetchActivities</b>(reqID, idSpec, opt_params)
					
					</div>
					<div class="description">
						Sends out the request for personal activities.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>reqID</b>
									
								</dt>
								<dd>The request id.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>idSpec</b>
									
								</dt>
								<dd>A wrapped <code>opensocial.IdSpec</code> object.</dd>
							
								<dt>
									<span class="light fixedFont">{Object.<opensocial.DataRequest.ActivityRequestField|Object>?}</span> <b>opt_params</b>
									
								</dt>
								<dd>A map of <code>opensocial.DataRequest.ActivityRequestField</code> names and
           values.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".requestCreateActivity"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">opensocial.flash.</span><b>requestCreateActivity</b>(reqID, activity, priority)
					
					</div>
					<div class="description">
						Sends out the request to creat an activity.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>reqID</b>
									
								</dt>
								<dd>The request id.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>activity</b>
									
								</dt>
								<dd>A wrapped <code>opensocial.Activity</code> object.</dd>
							
								<dt>
									<span class="light fixedFont">{opensocial.CreateActivityPriority | string}</span> <b>priority</b>
									
								</dt>
								<dd>An <code>opensocial.CreateActivityPriority</code> value.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".requestSendMessage"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">opensocial.flash.</span><b>requestSendMessage</b>(reqID, recipients, message)
					
					</div>
					<div class="description">
						Sends out the request to send a message.
<p>TODO: <code>opensocial.NavigationParameters opt_params</code> is not implemented.</p>
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>reqID</b>
									
								</dt>
								<dd>The request id.</dd>
							
								<dt>
									<span class="light fixedFont">{Array.<string>}</span> <b>recipients</b>
									
								</dt>
								<dd>An ID, array of IDs, or a group reference, like
           VIEWER, OWNER, VIEWER_FRIENDS, OWNER_FRIENDS.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>message</b>
									
								</dt>
								<dd>A wrapped <code>opensocial.Message</code> object.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".requestShareApp"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">opensocial.flash.</span><b>requestShareApp</b>(reqID, recipients, reason)
					
					</div>
					<div class="description">
						Sends out the request to share the app.
<p>TODO: <code>opensocial.NavigationParameters opt_params</code> is not implemented.</p>
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>reqID</b>
									
								</dt>
								<dd>The request id.</dd>
							
								<dt>
									<span class="light fixedFont">{Array.<string>}</span> <b>recipients</b>
									
								</dt>
								<dd>An ID, array of IDs, or a group reference, like
           VIEWER, OWNER, VIEWER_FRIENDS, OWNER_FRIENDS.</dd>
							
								<dt>
									<span class="light fixedFont">{Object}</span> <b>reason</b>
									
								</dt>
								<dd>A wrapped <code>opensocial.Message</code> object.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".requestPermission"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">opensocial.flash.</span><b>requestPermission</b>(reqID, permissions, reason)
					
					</div>
					<div class="description">
						Sends out the request permissions.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>reqID</b>
									
								</dt>
								<dd>The request id.</dd>
							
								<dt>
									<span class="light fixedFont">{Array.<opensocial.Permission | string>}</span> <b>permissions</b>
									
								</dt>
								<dd>An array of
           <code>opensocial.Permission</code> values.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>reason</b>
									
								</dt>
								<dd>Text of the reason to request the permissions.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".makeRequest"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">opensocial.flash.</span><b>makeRequest</b>(reqID, url, opt_params)
					
					</div>
					<div class="description">
						Sends request to a remote site to get or post data.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>reqID</b>
									
								</dt>
								<dd>The request id.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>url</b>
									
								</dt>
								<dd>The remote site</dd>
							
								<dt>
									<span class="light fixedFont">{Object.<gadgets.io.RequestParameters|Object>?}</span> <b>opt_params</b>
									
								</dt>
								<dd>Parameters for the request</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".callRpc"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">opensocial.flash.</span><b>callRpc</b>(reqID, targetId, serviceName, argsArray)
					
					</div>
					<div class="description">
						Sends the rpc call request to a service on another app or container on the page.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>reqID</b>
									
								</dt>
								<dd>The request id.</dd>
							
								<dt>
									<span class="light fixedFont">{string?}</span> <b>targetId</b>
									
								</dt>
								<dd>The target app id, null to call the parent.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>serviceName</b>
									
								</dt>
								<dd>The service name registered on the target.</dd>
							
								<dt>
									<span class="light fixedFont">{Array.<Object>?}</span> <b>argsArray</b>
									
								</dt>
								<dd>The array of args to be passed to the service.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".returnRpcService"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">opensocial.flash.</span><b>returnRpcService</b>(callID, opt_returnValue)
					
					</div>
					<div class="description">
						Sends the return value to to last received rpc service back to the caller app. Only 
callback if the returnValue is available.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>callID</b>
									
								</dt>
								<dd>The call id for the rpc called by the caller app.</dd>
							
								<dt>
									<span class="light fixedFont">{Object?}</span> <b>opt_returnValue</b>
									
								</dt>
								<dd>The return value of the rpc service.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".registerRpcService"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">opensocial.flash.</span><b>registerRpcService</b>(serviceName, handlerName)
					
					</div>
					<div class="description">
						Sends the rpc register request to container to register a service on this app.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>serviceName</b>
									
								</dt>
								<dd>The service to be register.</dd>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>handlerName</b>
									
								</dt>
								<dd>The handler function name on the flash object.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".unregisterRpcService"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					
					<span class="light">opensocial.flash.</span><b>unregisterRpcService</b>(serviceName)
					
					</div>
					<div class="description">
						Sends the rpc unregister request to container.
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string}</span> <b>serviceName</b>
									
								</dt>
								<dd>The service to be unregister.</dd>
							
							</dl>
						
						
						
						
						
						
						

					<hr />
				
					<a name=".jsReady"> </a>
					<div class="fixedFont">&lt;static&gt; 
					
					<span class="light">{boolean}</span>
					<span class="light">opensocial.flash.</span><b>jsReady</b>(objectId)
					
					</div>
					<div class="description">
						Indicates if the opensocial library is loaded and initialize the flash element.
<p>
The objectId of the swf is defined in gagdet spec. If the swf is embeded by calling
<code>opensocial.flash.embedFlash</code> function, the detault objectId will be 'flashObj'.
</p><p>
This function is called by the swf's <code>ExternalInterface</code> continuingly until it
returns true.
</p>
						
						
					</div>
					
					
					
						
							<dl class="detailList">
							<dt class="heading">Parameters:</dt>
							
								<dt>
									<span class="light fixedFont">{string?}</span> <b>objectId</b>
									
								</dt>
								<dd>The object Id passed from the swf.</dd>
							
							</dl>
						
						
						
						
						
							<dl class="detailList">
							<dt class="heading">Returns:</dt>
							
								<dd><span class="light fixedFont">{boolean}</span> true if all javascripts are loaded.</dd>
							
							</dl>
						
						
						

					
				
			
			
<!-- ============================== event details ========================= -->		
			
			
			<hr />
		</div>

		
<!-- ============================== footer ================================= -->
		<div class="fineprint" style="clear:both">
			
			Documentation generated by <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a> 2.1.0 on Sat Apr 18 2009 21:33:34 GMT+0800 (CST)
		</div>
	</body>
</html>
